<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>download ACS 5year data from Census API, at block group resolution (slowly for entire US) — acs_bybg • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="download ACS 5year data from Census API, at block group resolution (slowly for entire US) — acs_bybg"><meta name="description" content="download ACS 5year data from Census API, at block group resolution (slowly for entire US)"><meta property="og:description" content="download ACS 5year data from Census API, at block group resolution (slowly for entire US)"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>download ACS 5year data from Census API, at block group resolution (slowly for entire US)</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/acs_bybg.R" class="external-link"><code>R/acs_bybg.R</code></a></small>
      <div class="d-none name"><code>acs_bybg.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>download ACS 5year data from Census API, at block group resolution (slowly for entire US)</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">acs_bybg</span><span class="op">(</span></span>
<span>  variables <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span>pop <span class="op">=</span> <span class="st">"B01001_001"</span><span class="op">)</span>,</span>
<span>  table <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  cache_table <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  year <span class="op">=</span> <span class="fl">2022</span>,</span>
<span>  output <span class="op">=</span> <span class="st">"wide"</span>,</span>
<span>  state <span class="op">=</span> <span class="fu">EJAM</span><span class="fu">::</span><span class="va"><a href="stateinfo.html">stateinfo</a></span><span class="op">$</span><span class="va">ST</span>,</span>
<span>  county <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  zcta <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  geometry <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  keep_geo_vars <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  summary_var <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  key <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  moe_level <span class="op">=</span> <span class="fl">90</span>,</span>
<span>  survey <span class="op">=</span> <span class="st">"acs5"</span>,</span>
<span>  show_call <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  geography <span class="op">=</span> <span class="st">"block group"</span>,</span>
<span>  dropname <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-variables">variables<a class="anchor" aria-label="anchor" href="#arg-variables"></a></dt>
<dd><p>Vector of variables - see get_acs from tidycensus package</p></dd>


<dt id="arg-table">table<a class="anchor" aria-label="anchor" href="#arg-table"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-cache-table">cache_table<a class="anchor" aria-label="anchor" href="#arg-cache-table"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-year">year<a class="anchor" aria-label="anchor" href="#arg-year"></a></dt>
<dd><p>e.g., 2022  see get_acs from tidycensus package</p></dd>


<dt id="arg-output">output<a class="anchor" aria-label="anchor" href="#arg-output"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-state">state<a class="anchor" aria-label="anchor" href="#arg-state"></a></dt>
<dd><p>Default is 2-character abbreviations, vector of all US States, DC, and PR.</p></dd>


<dt id="arg-county">county<a class="anchor" aria-label="anchor" href="#arg-county"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-zcta">zcta<a class="anchor" aria-label="anchor" href="#arg-zcta"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-geometry">geometry<a class="anchor" aria-label="anchor" href="#arg-geometry"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-keep-geo-vars">keep_geo_vars<a class="anchor" aria-label="anchor" href="#arg-keep-geo-vars"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-summary-var">summary_var<a class="anchor" aria-label="anchor" href="#arg-summary-var"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-key">key<a class="anchor" aria-label="anchor" href="#arg-key"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-moe-level">moe_level<a class="anchor" aria-label="anchor" href="#arg-moe-level"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-survey">survey<a class="anchor" aria-label="anchor" href="#arg-survey"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-show-call">show_call<a class="anchor" aria-label="anchor" href="#arg-show-call"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>


<dt id="arg-geography">geography<a class="anchor" aria-label="anchor" href="#arg-geography"></a></dt>
<dd><p>"block group"</p></dd>


<dt id="arg-dropname">dropname<a class="anchor" aria-label="anchor" href="#arg-dropname"></a></dt>
<dd><p>whether to drop the column called NAME</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>see get_acs from tidycensus package</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>data.table (not tibble, and not just a data.frame)</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co">## All states, full table</span></span>
<span><span class="co"># newvars &lt;- acs_bybg(table = "B01001")</span></span>
<span></span>
<span><span class="co">## One state, some variables</span></span>
<span><span class="va">newvars</span> <span class="op">&lt;-</span> <span class="fu">acs_bybg</span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span>pop <span class="op">=</span> <span class="st">"B01001_001"</span>, y <span class="op">=</span> <span class="st">"B01001_002"</span><span class="op">)</span>, state <span class="op">=</span> <span class="st">"DC"</span><span class="op">)</span></span>
<span></span>
<span><span class="co">## Format new data to match rows of blockgroupstats</span></span>
<span></span>
<span><span class="fu">setnames</span><span class="op">(</span><span class="va">newvars</span>, <span class="st">"GEOID"</span>, <span class="st">"bgfips"</span><span class="op">)</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/dim.html" class="external-link">dim</a></span><span class="op">(</span><span class="va">newvars</span><span class="op">)</span></span>
<span><span class="va">newvars</span> <span class="op">&lt;-</span> <span class="va">newvars</span><span class="op">[</span><span class="va">blockgroupstats</span><span class="op">[</span>,<span class="fu">.</span><span class="op">(</span><span class="va">bgfips</span>, <span class="va">ST</span><span class="op">)</span><span class="op">]</span>, ,  on <span class="op">=</span> <span class="st">"bgfips"</span><span class="op">]</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/dim.html" class="external-link">dim</a></span><span class="op">(</span><span class="va">blockgroupstats</span><span class="op">)</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/dim.html" class="external-link">dim</a></span><span class="op">(</span><span class="va">newvars</span><span class="op">)</span></span>
<span><span class="va">newvars</span></span>
<span><span class="va">newvars</span><span class="op">[</span><span class="va">ST</span> <span class="op">==</span> <span class="st">"DC"</span>, <span class="op">]</span></span>
<span></span>
<span><span class="co">## Calculate a new indicator for each block group, using ACS data</span></span>
<span></span>
<span><span class="va">newvars</span> <span class="op">&lt;-</span> <span class="fu">acs_bybg</span><span class="op">(</span>variables <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"B01001_001"</span>, <span class="fu"><a href="https://rdrr.io/r/base/paste.html" class="external-link">paste0</a></span><span class="op">(</span><span class="st">"B01001_0"</span>, <span class="fl">31</span><span class="op">:</span><span class="fl">39</span><span class="op">)</span><span class="op">)</span>,</span>
<span>  state <span class="op">=</span> <span class="st">"DC"</span><span class="op">)</span></span>
<span><span class="fu">setnames</span><span class="op">(</span><span class="va">newvars</span>, <span class="st">"GEOID"</span>, <span class="st">"bgfips"</span><span class="op">)</span></span>
<span><span class="va">newvars</span> <span class="op">&lt;-</span> <span class="va">newvars</span><span class="op">[</span><span class="va">blockgroupstats</span><span class="op">[</span>, <span class="fu">.</span><span class="op">(</span><span class="va">bgfips</span>, <span class="va">ST</span><span class="op">)</span><span class="op">]</span>, , on <span class="op">=</span> <span class="st">"bgfips"</span><span class="op">]</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">newvars</span><span class="op">)</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/grep.html" class="external-link">gsub</a></span><span class="op">(</span><span class="st">"E$"</span>, <span class="st">""</span>, <span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">newvars</span><span class="op">)</span><span class="op">)</span></span>
<span><span class="va">formula1</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span></span>
<span> <span class="st">"pop = B01001_001"</span>,</span>
<span> <span class="st">"age1849female = (B01001_031 + B01001_032 + B01001_033 + B01001_034 + </span></span>
<span><span class="st"> B01001_035 + B01001_036 + B01001_037 + B01001_038 + B01001_039)"</span>, </span>
<span> <span class="st">"pct1849female = ifelse(pop == 0, 0, age1849female / pop)"</span><span class="op">)</span></span>
<span><span class="va">newvars</span> <span class="op">&lt;-</span> <span class="fu"><a href="calc_ejam.html">calc_ejam</a></span><span class="op">(</span><span class="va">newvars</span>, formulas <span class="op">=</span> <span class="va">formula1</span>, </span>
<span>  keep.old <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"bgid"</span>, <span class="st">"ST"</span>, <span class="st">"pop"</span><span class="op">)</span><span class="op">)</span></span>
<span><span class="va">newvars</span><span class="op">[</span><span class="va">ST</span> <span class="op">==</span> <span class="st">"DC"</span>, <span class="op">]</span></span>
<span></span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

